Vstats CounterMetadata Info

The Vstats CounterMetadata Info schema contains information about CounterMetadata. It represents edition of the Counter.

Warning: this schema is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

JSON Example

{
    "cid": "string",
    "mid": "string",
    "status": "string",
    "type": "string",
    "units": "string",
    "scale": "string",
    "user_info": {
        "label": {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        },
        "description": {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    },
    "pid": "string"
}

string

cid

Required

Counter Id.

Warning: this property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Counter. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.Counter.

string

mid

Required

Metadata Id.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.CounterMetadata.

string

status

Required

Counter Edition status.

For more information see: Vstats CounterMetadata CounterEditionStatus.

string

type

Required

Numeric properties of the sampled data.

For more information see: Vstats CounterMetadata SampleType.

string

units

Required

The units of the measurement.

For more information see: Vstats CounterMetadata MetricUnits.

string

scale

Optional

Additional multiplier factors to be used with units.

For more information see: Vstats CounterMetadata UnitsFactor.

When missing or null default of ONE is used.

user_info

Optional

Human legible localizable text about the counter.

This property is missing or null in the current version.

string

pid

Optional

ID of the respective provider.

This property is missing or null in the current version.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vstats.model.Provider. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vstats.model.Provider.

Returned By

Vstats CounterMetadata get